home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
SPACE 1
/
SPACE - Library 1 - Volume 1.iso
/
apps
/
237
/
doc_supp
/
stxfii.doc
< prev
Wrap
Text File
|
1991-12-27
|
28KB
|
789 lines
ST XFORMER II Short Documentation
---------------------------------
This file must accompany STXFII.PRG!!
This file is the short documentation included with ST Xformer II. There
is online help in the program itself, and registered users will be sent
the ST Xformer II Manual, which explains all the topics covered here in
greater detail (with illustrations!).
Contents of this file:
----------------------
Part I - Shareware and registration instructions 2
Part II - Summary of Features 4
Part III - Changes from Xformer 1.2 5
Part IV - Atari 800/800XL/130XE emulation 6
Part V - Apple and Commodore emulation 9
Part VI - Updates and future versions 10
Part VII - Invitation to 8 bit programmers 11
Part VIII - Closing comments 12
Page 1
Part I
______
If you're like me, you probably get really ticked off when you buy a
piece of software and discover that it doesn't do what you though it
should do, or does it very badly. Or, as is the case with some very
recent software that shall remain unnamed to protect those guilty of
producing it, the program is whipped together in a week and is more of a
beta release than a real usable product.
Unfortunately, with the "Buy First, Suffer Later" attitude of some
dealers and fly-by-night software companies, there isn't much you can do
about trying out the software before buying, short of downloading the
program from a pirate BBS. And they wonder why piracy is so widespread
on the ST!
Realizing this, I decided that the best way to distribute Xformer II
would be as shareware and not as a commercial product. This solves
several problems.
First, the program is freely available nationwide on Atari BBSs and on
information services like Compuserve and GEnie. That means that
obtaining a copy is as easy as dialing your local BBS and downloading
it. It can't be pirated, so pirate boards can only help to increase the
availability of the program.
Second, no one will get ticked off at blowing money on a worthless
product, since no money was spent. This allows everyone interested in
Xformer II to try it out first, on their systems at home, and judge its
usefulness.
Third, those people satisfied with Xformer can then send in their $15
registration fee, and receive the manual and updated software. For $15,
they end up spending a lot less than they would have at a dealer, had
Xformer II been marketed in the usual way.
Shareware only works if users send in their registration fees. So
please, if you end up using Xformer regularly, it is in your best
interest (and mine) to register. You will receive an illustrated manual
(laser printed even!) that guides you step by step through all of
Xformer's features, and contains tips on converting 8 bit software to
run on the ST. You will also get an up to the minute list of compatible
software. I'll also send you a disk with the latest version of Xformer
II.
I also recommend that you send me a 3 1/2" disk containing 8 bit files
that you have ported over to the ST. I will look at these files and find
ones that work and place them on the compatibility list. Programs that
don't work will be examined and either patched up to work, or Xformer
will be updated if necessary. In any case, I'll send you your disk back
with 720K of the 8 bit software sent in from other users.
Remember, I've spent 2 years and 1000+ hours developing Xformer to its
current state. This is more time than is spent developing some
commercial software, and is certainly more time than is spent on other
shareware programs (asking even higher fees). I'd like to prove that
shareware can and does work. This might convince other software writers
to release their programs as shareware too.
Page 2
If things go well enough, I'll set up a BBS for registered users to
automate the whole process of updates.
So, to become a registered user, send $15 (U.S funds) or $20 (Canadian
dollars) to:
Darek Mihocka
310-D Bluevale St. N.
Waterloo, Ontario N2J 4G3
CANADA
Please include your name and telephone number, and of course, your
address!
My voice number is (519)-747-0386. Call it 24 hours a day, 7 days a
week. I won't be there most of the time, but if I am, I'll answer your
questions.
Page 3
Part II
-------
ST Xformer II is a software emulator of the 6502 microprocessor. On a
standard ST, running on a 68000 at 8 MHz, it executes roughly 80,000 to
100,000 instructions per second, or about 40% the speed of a 6502
machine. It hasn't been tested on any of the accelerator boards now out
for the ST.
In addition to the 6502 emulation, 3 hardware emulation modes are
available: Atari 800/XL/XE, Apple ][, and Commodore 64. NOTE: in this
release only the Atari emulation can be accessed. Each of the hardware
emulation modes is explained later.
ST Xformer II is GEM based, and runs on any color or monochrome ST
system with at least 1 Megabyte of memory. It runs off floppy or the
hard disk. It must be booted in either medium (80 column color) or high
(monochrome) resolution.
If the program runs out of memory (800K is required) or it is booted in
low resolution, an error message appears and the program exists.
Therefore, if you only have a 1 Meg machine, make sure all memory
intensive desk accessories and AUTO boot programs are disabled.
Xformer works on 1040 ROMs, Mega ROMs, and the "new" ROMs.
Online help can be accessed from the menu bar under the "Help" entry. It
very briefly summarizes the most common procedures.
Atari 800 support now includes DOS and non-DOS disk support, Player
Missle Graphics, emulation of most of the NMI and IRQ interrupts, and
emulation of most of the ANTIC, POKEY, and GTIA hardware registers. This
release has 2 promised features missing (hey, this program took a _lot_
longer to write than planned): display list interrupt support, and XL/XE
bank select memory emulation. Other less serious cosmetic problems are
the lack of GTIA support. I simply ran out of colors registers on the
ST. These bugs, and any others reported by users will be fixed an
available on the update disk for registered users.
Page 4
Part III
--------
Xformer II represents over 6 months of effort on my part to take the
various Xformer 1.x versions and join them into one unit. Thus, Xformer
II replaces the Xformer 1.1 and 1.2 Atari 800 emulators, and the Xformer
1.0x Apple ][ emulator, which never really got released.
The user interface is totally redesigned. Instead of a text based
keyboard entry style interface, Xformer II uses GEM for most of its
functions. This greatly improves usability, which was one major
complaint of the previous emulators.
Xformer II also runs twice as fast as the previous versions. The 6502
emulator was rewritten to use a different p-code interpretter algorithm,
and all the assembly code was tightened up even more.
Xformer II does away with all the extra files that were required for use
with previous versions. The Atari ROMs are stored in STXFII.PRG itself,
and DOS emulation is handled differently, as explained in the Atari
section.
Page 5
Part IV
-------
Yep, if you're still reading this file, you made it to the Atari
emulation documentation. (yay! whopee!) You've still got pages to go!
If you currently use Xformer 1.1 or 1.2, forget everything you know!
I've redesigned everything. STXFII.PRG now contains all the Atari ROM
code built in to it, so you no longer need to rename files and do all
the silly things I required you to do (he he).
When you boot the program, click the Atari logo on the title screen.
Then go up to the "Xformer II" menu entry and select the Atari option.
An Atari Configuraton dialog box will appear.
It should be fairly self explanatory. You can select either Atari
400/800 ROMs (also known as ROM revision B) or the XL/XE ROMs, which
give you the faster text and graphics output, and access to graphics
modes 12, 13, 14 and 15.
Thanks to Charles Marslett's fine work on the Fastchip floating point,
and with his permission, you can select between the regular Atari
floating point routines, or his Fastchip routines, which can increase
the speed of math operations (and BASIC) by up to a factor of 3.
Speaking of BASIC, you can have it either IN or OUT. Xformer II no
longer supports any other cartridges, since no one ever indicated to me
that they used that feature. However, cartridges transfered to disk will
work. More on disk files in a few paragraphs.
There is one rather cryptic option called "VBI Rate". This refers to how
often the emulator emulates vertical blank interrupts. The default is 1,
which means an Atari 800 VBI occurs every 1 ST vertical blank, i.e. 60
times per seconds. Similarly, setting this option to 2 will give you a
60/2 = 30Hz VBI rate, and setting it to 3 sets it to 60/3 = 20Hz.
WHY??????? (you ask?) Simple. The standard operating system vertical
blank interrupts take up about 3 or 4% or the total processor time on an
Atari 800. On the emulator though, which still has to process the same
number of VBI's each second, (but does it at a slower speed), about 15 -
20% of the time is spent servicing the interrupts. This slows down most
programs by 15 or 20%. Therefore Atari BASIC appears to run at about 30%
the normal speed. To fix this, I added the option so that you can reduce
the number of VBI's, and give more processor time back to programs like
BASIC. Try it at a setting of 3. BASIC now speeds up to over 35%. Kill
vertical blanks all together (with a POKE 54286,0) and the emulator now
runs at over 40% speed.
Now, the disk support. Read this CAREFULLY!!
On a regular 5 1/4" single sided single density floppy disk, formatted
on an 810 disk drive, you will get 90K of storage. This is derived by
taking the number of tracks (40), the number of sectors per track (18)
and the number of bytes per sector (128) to give a total of 40*18*128 =
92160 = 90K. Unfortunately, try as hard as I could with an external 5
1/4" drive hooked up to my ST, I could not get it to read my disks.
Therefore I selected the following method to emulate the 810 disk drive.
THIS IS DIFFERENT THAN THE METHOD USED IN XFORMER 1.2!!!!!
Page 6
In this ARC file there is a file called DEMODISK.SD. Notice that it is
92160 bytes long, exactly the number of bytes of storage on a floppy.
The .SD file is an exact bit image of a floppy disk. All 720 sectors
were copied to the ST and stored in this file.
What does this mean to you? Well it means that instead of porting files
one by one to the ST, you can port over entire disks! The disks must be
formatted in single density and unprotected, but besides that, there is
no limit to what can be on the disk. I have tested Xformer II with DOS
2.0, DOS 2.5, DOS 4.0, Sparta DOS 1.1, and MyDos 4.1 with full success.
All the other DOSes _should_ work assuming you configure them for an 810
drive _before_ porting the disk over.
Now, how do you port a disk? Most of you should be familiar with the
Disk Communicator program by Robert Puff. It is known simply as
DiskComm, and 3.2 is the latest version. Note that DC32.COM is supplied.
DiskComm is basically a disk scruncher and unscruncher. It takes a disk
and compresses it into a single file, which can be easily transfered by
modem to another computer, and uncompressed.
Now, boot up your favorite terminal software on your 8 bit Atari, and
boot up your favorite ST terminal software, set them both to XMODEM, and
port DC32.COM to your 8 bit. Even if you already have Diskcomm on your 8
bit port over this version!!!!!
Now, reboot the 8 bit computer and run Diskcomm. It will allow you to
set the source and destination drives. The SOURCE drive is the drive
which contains the disk to be ported. The DESTINATION drive is where you
will insert a blank formatted disk, to which the source disk will get
written out as a file.
When this is done, boot up the terminal software again, and
transfer the disk file (should have a .DSC extender) to the ST.
Now run Xformer II and enter the Atari Configuration dialog box again.
Click on "Insert...", then click on D1:, and when the file selector
appears, select DEMODISK.SD. Now repeat this but select D2: as the drive
to load. What you have just done is loaded the 2 virtual Atari 810
drives that Xformer II emulates with 2 identical disks.
Before you boot though, you will want to copy Diskcomm into one of the
virtual 810 drives. To do this click on the button marked "Utils".
Another dialog box will appear, and click on the button marked "File to
D:". This allows you to take a file off your ST disk and merge it into
an .SD file, in effect, copying a file onto one of these 810 disk files.
Ok, you've clicked on it, so another file selector appears. Select
DC32.COM and the Xformer will copy the file from the ST disk and onto
the virtual D1: disk, stored in Xformer's memory.
Now exit this and go up to "Xformer II" and select "Reboot". Voila! The
Atari 800 boots. If you had BASIC plugged IN, you should see the word
READY on the screen. If so, type in DOS and press RETURN. Atari DOS 2.5
will load.
I assume that most people are familiar enough with DOS that they don't
need instructions. If you do, the documentation I supply to registered
users will among other things, explain Atari DOS.
Page 7
From DOS, format D2:, then write out the DOS files to it. What you are
doing is creating a blank DOS 2.5 disk.
Now press F5 to exit the emulation, and go back into the Atari
Configuration box. Click on "Eject..." and select D1:. When the file
selector appears, click on DEMODISK.SD again. What you've done is to
save an updated version of DEMODISK to your ST disk, which now contains
Diskcomm 3.2 on it. Similarly, save out D2: to a file called DOS25.SD
(or whatever name you choose). Use this file as the seed for all further
.SD files that you create.
Now, go to "Utils" again, and copy the .DSC file you created earlier on
your 8 bit to D2: (the blank DOS 2.5 disk). Hopefully it will fit. If
not, reformat D2: and don't write DOS to it.
Now, make sure that Atari BASIC is OUT, and "Reboot" the Atari 800. Run
DiskComm and choose D2: as the source and D1: as the destination. What
you are going to do is uncompress the .DSC file now on D2: and put the
uncompressed disk image on D1:. Yes, this will overwrite the files from
DEMODISK, but don't worry, it is safely stored on your ST disk.
Now start DiskComm and watch the sectors fly. In a few minutes, it will
be finished. Now press F5 again, click on "Eject...", and save this
newly created D1 to a new .SD file. For example, if you ported over the
latest Analog monthly disk, you may want to call the file ANLG0788.SD.
Reboot the Atari 800 again and the new disk will boot.
SOUND COMPLICATED?!?!?!?!?!?!?!?!?!?!?!?!!?
It isn't really. If you think of the 2 virtual disk drives in Xformer II
as 2 810 disk drives hooked up to an Atari 800, you see that you're
doing nothing more than creating and copying files around on a 2 disk
drive system.
Oh, did I mention the Disk I/O option? This allows you turn off the
"beep beep beep" sound of the disk drive and just do fast disk
emulation. Useful when running DiskComm but you may wish to keep the
sound for old time's sake.
Enough "Now"s!
Page 8
Part V
------
Well, 5 months after getting the first signs of life out of Commodore
Basic running under C64 emulation, Commodore Business Machines has still
to return a single phone call of mine. Whenever I phone back, I'm put on
hold, transfered, asked for my name and number, and goodbye Charlie!
Obviously, Commodore has not learned how _not_ to practise public
relations. At least with Apple I got as far as getting several
"NO!!!!!!"s when I suggested that they licence their ROMs to me for use
with Xformer.
So, since neither one of those companies wishes to talk, perhaps someone
can guide me to a manufacturer of clone machines, or better yet, to
someone that has written compatible versions of either the Apple R ]R [
operating system, or the Commodore 64 OS. I believe that both such
beasts exist, (definately Apple clone ROMs) but I am unable to actually
find a _legitemate_ manufacturer. Anyone with information, _please_
forward it to me. The day I get the clone code is the day Xformer II
goes up with the Apple R ]R [ and/or C64 options enabled.
Sorry folks, short of rewriting the Apple and C64 OS code myself, I
cannot enable those two options. It's too bad that Apple and Commodore
have decided to be so protective of their 'precious' ROMs. It is code
that is now 5 or 10 years old, obsolete, and wouldn't hurt their sales
whatsoever. It could only help boost interest in their machines and the
software. But I guess the only thing they'll listen to is the sound of
cash registers.
J. Andrzej Wrotniak said it best in his latest Current Notes article
(June 1988 Vol. 8 No. 5 page 38) when he was talking about Apple suing
everybody left and right over the Mac interface (which was developed in
the 70's by XEROX, and stolen by Apple). He said, "the next thing they
may want to do is to claim rights to the rectangular shape of the
computer screen." C'mon all you computer companies, lighten up and talk
to me!
Page 9
Part VI
-------
With the release of ST Xformer II, I hope to hear from many different ST
users from all over the U.S. and Canada. Work on ST Xformer II will
continue on through the summer, (pausing for the long weekends of
course!) and an update version with the missing Atari functionality
should be out by August. Also, if I can get somewhere regarding the
Apple and C64 ROM issues, those features will be made available also.
I've already had several requests to make Xformer II 520ST compatible.
This would require getting rid of all the GEM support, and some of the
functionality, but I do believe a version of an Atari 800 emulator can
be made for 512K machines without any loss of speed or compatibility. If
I succeed, I'll make it available on all the same places Xformer II is
now on.
As I already mentioned, I still have to put in the bank select memory
emulation for real 800XL and 130XE support. That should be in soon, and
registered users will receive it on their update disks.
Also, I need to get some feedback from users regarding what software
runs, how well, what doesn't run, and how bad. Also, any suggestions
regarding the user interface or features that could be put in (have I
forgotten to emulate something?) are most welcome!
I would also be very interested in porting this program over to the Mac
II and the Amiga. From what I've heard of the C64 emulators on the
Amiga, they're far slower than the Xformer, (probably because they're
using the standard p-code interpreter code used in Xformer 1.2). I think
Xformer II could blow them out of the water. And on the Mac II, well,
multiply the speed of Xformer by about 5, and you get the speed it would
run at on a Mac II. Anyone interested, simply send a Mac II or Amiga
2000 to the same address already given above, and I'll gladly start
porting the code over. Both Commodore and Apple seem to have no
complaints about emulators running on _their_ machines. Also, if anyone
wants to send me a Mega ST 2 or 4, I'll be glad to add support for all
drives D1: thru D8:, double and single density. (Maybe call it the Mega
Xformer??) Unfortunately, on a 1 Meg machine, (with which Xformers are
developed on) there is only enough memory to support D1: and D2: in
single density.
Page 10
Part VII
--------
This is an open invitation to all Atari 8 bit programmers to try their
software on the Xformer and see how it runs. If it runs well, advertize
that fact. Let people know that your software is "Xformer II
Compatible".
If it doesn't run well, but it is a small problem to fix, please take a
few minutes to adjust your software to make it Xformer Compatible. Since
most of the incompatibilities will be in the area of speed, it is
usually simply a matter of adjusting your timing loops. To help you
detect the Xformer, I have modified hardware register $D015 to always
return the value $C0 instead of $0F. This is your way of detecting the
Xformer at run-time, so that proper adjustments can be made.
If your software does not run at all, but you are interested in allowing
ST users run your software, please send me a copy of your software, and
if possible, a listing, or simply a list of possible trouble points, and
I'll try to fix the problem in updates of Xformer II.
Page 11
Part VIII
---------
There is a section in Xformer II called "Scratch 'n Sniff". This is a
billboard on which Atari related products or services can be advertized.
It is still not too late to place your ad. I charge reasonable rates.
Ask the current bunch of paid advertizers!
Also, any sysops of Atari ST bulletin boards who would like to advertize
their BBSs should send me a letter with the important info. Again,
reasonable rates will be charged.
User groups wishing to advertize themselves should send me their 3 most
recent newsletters and their ad. No charge.
Anyone who gets a chance to try Xformer II on any of the 14 or 16 MHz
accelerator boards, please let me know if it runs, and if so, how much
faster.
I have to acknowledge some of the people whose ideas made Xformer II a
reality. First there's Charles Smeton, who soon after the release of
Xformer 1.1 pointed out to me on GEnie a code optimization that I now
use in Xformer II. Just before that, David Small, at a show in Toronto,
scribbled down his ideas on speeding up Xformer which later turned out
to be the foundation of Xformer II. Actually, Jan Grey, fellow
University of Waterloo student, ST owner, and Microsoft employee, had
the same idea about 6 months earlier, but (sorry Jan) I though he was
kidding when showed me the code! Fortunately after I refined David's
idea into real code, Jan came up with the ultimate speed hack. And of
course, there's Bill Teal, who's trying to do the same thing I am but
for a different CPU (and doing it better!), who pointed out a few things
I could do, and did, to make Xformer II faster. The final result, as you
already know, was a 100% increase in speed over the previous Xformers.
Then of course, there's the people who's comments were so depressing
that I felt like giving up on Xformer II altogether. You know who you
are, and I hope you've changed your minds about the idea of software
emulators, since you not only put down Xformer but PC Ditto and the CP/M
emulator as well. But one thorn that still sticks in my side are
comments made by various members of COMPUTE magazine. May you fold soon!
Enough said.
Also, in the works: ST Xformer III 6502 emulator and compiler. Does all
the things this one can with one small difference. Programs are first
compiled into native 68000 code, _then_ executed. This should allow most
Atari 800 programs to run at least 2 or 3 times their normal speed!
Finally, I'd just like to remind everyone once again that the ST Xformer
II _is_ a shareware product. It is _not_ public domain. Therefore, if
you use it, please pay for it. Out of the $15 you send, almost half of
that will go back to you in the form of the documentation, update disk,
and of course, postage. I think I'm making a very fair deal here, so
let's see shareware work. I don't want to become another one of the
already too large group of ST programmers who put out a shareware
product, only to see it be used by everyone and paid for by no one.
BIX, DELPHI, GENIE: DAREKM Compuserve: 73657,2714
Xformer Hotline: (519)-747-0386
Send your registration money ($15 US or $20 Canadian) to:
310-D Bluevale St. N., Waterloo, Ontario, CANADA N2J 4G3